Investigator API

POST Search TaxChanges By Pgpi

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

Performs a pgpi operation.

OperationId: POST Search TaxChanges By Pgpi

Authorization Method(s): OAuth

Verb: POST

End Point: /api/taxchanges/search/pgpi

Request Body

OVERVIEWEXAMPLE

Request Model

Display Name	Field Name	Field Type
Client Number *	clientNumber	string
Search Country	searchCountry	SearchCountry
Search Option	searchOption	SearchOption
Search Type	searchType	string
Filters	filters	CommonSearchFilters
Parameters	parameters	CommonSearchParameters

SearchCountry

Display Name	Field Name	Field Type

SearchOption

Display Name	Field Name	Field Type

CommonSearchFilters

Display Name	Field Name	Field Type
Customer Usage Type *	customerUsageType	string
Provider Type *	providerType	providerTypes
Start Date	startDate	DataYearMonth
End Date	endDate	DataYearMonth
Release Number	releaseNumber	integer
Date Type	dateType	SearchDateType

DataYearMonth

Display Name	Field Name	Field Type
Year *	year	string
Month *	month	string
Day	day	integer

DataYearMonth

Display Name	Field Name	Field Type
Year *	year	string
Month *	month	string
Day	day	integer

SearchDateType

Display Name	Field Name	Field Type

CommonSearchParameters

Display Name	Field Name	Field Type
Pgpis	pgpis	array[Pgpi]
Postal Code	postalCode	string
Npanxx	npanxx	string
Locations	locations	array[]
Address	address	Address
State County City	stateCountyCity	StateCountyCity
Geocode	geocode	string
By	by	SearchListItemsBy
Skus	skus	array[]

Pgpi

Display Name	Field Name	Field Type
Product Group	productGroup	string
Product Item	productItem	string

Address

Display Name	Field Name	Field Type
Address1	address1	string
Address2	address2	string
City	city	string
County	county	string
Postal Code	postalCode	string
Plus4	plus4	string
State	state	string

StateCountyCity

Display Name	Field Name	Field Type
State *	state	string
County	county	string
City	city	string

SearchListItemsBy

Display Name	Field Name	Field Type

Example Request

{
  "filters": {
    "customerUsageType": "07",
    "providerType": "80",
    "startDate": {
      "year": "2024",
      "month": "12",
      "day": 1
    },
    "endDate": {
      "year": "2025",
      "month": "01",
      "day": 1
    },
    "releaseNumber": null,
    "dateType": "Date"
  },
  "parameters": {
    "pgpis": [],
    "postalCode": null,
    "npanxx": null,
    "locations": null,
    "address": null,
    "stateCountyCity": null,
    "geocode": "US48113A0004",
    "by": "ProductGroupItem",
    "skus": []
  },
  "clientNumber": "ZREGRSV06",
  "searchCountry": "UnitedStates",
  "searchOption": "Geocode",
  "searchType": "TaxabilityChanges"
}

Query Parameters

Display String	Field Name	Field Type
Api-version*	api-version	undefined

*Mandatory parameter

ProblemDetails

OVERVIEWEXAMPLE

Overview

ProblemDetails

Display Name	Field Name	Field Type
Type	type	string
Title	title	string
Status	status	integer
Detail	detail	string
Instance	instance	string

Example Response

{
  "pgpiResult": [
    {
      "productGroups": [
        {
          "group": "0111",
          "groupDescription": "ALCOHOLIC BEVERAGES-GROCERY",
          "items": [
            {
              "item": "006",
              "itemDescription": "READY TO DRINK COCKTAILS"
            }
          ]
        }
      ]
    }
  ]
}

Response Codes

code	description
200	Returns the result of the pgpi operation.
400	Invalid request to call the API.
401	User is not authorized to access the API.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/taxchanges/search/pgpi

Add Request Headers:

{
  "filters": {
    "customerUsageType": "07",
    "providerType": "80",
    "startDate": {
      "year": "2024",
      "month": "12",
      "day": 1
    },
    "endDate": {
      "year": "2025",
      "month": "01",
      "day": 1
    },
    "releaseNumber": null,
    "dateType": "Date"
  },
  "parameters": {
    "pgpis": [],
    "postalCode": null,
    "npanxx": null,
    "locations": null,
    "address": null,
    "stateCountyCity": null,
    "geocode": "US48113A0004",
    "by": "ProductGroupItem",
    "skus": []
  },
  "clientNumber": "ZREGRSV06",
  "searchCountry": "UnitedStates",
  "searchOption": "Geocode",
  "searchType": "TaxabilityChanges"
}